home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / webbrwsr / nsITooltipTextProvider.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-05-08  |  3.6 KB  |  123 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsITooltipTextProvider.idl
  3.  */
  4.  
  5. #ifndef __gen_nsITooltipTextProvider_h__
  6. #define __gen_nsITooltipTextProvider_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17. class nsIDOMNode; /* forward declaration */
  18.  
  19.  
  20. /* starting interface:    nsITooltipTextProvider */
  21. #define NS_ITOOLTIPTEXTPROVIDER_IID_STR "b128a1e6-44f3-4331-8fbe-5af360ff21ee"
  22.  
  23. #define NS_ITOOLTIPTEXTPROVIDER_IID \
  24.   {0xb128a1e6, 0x44f3, 0x4331, \
  25.     { 0x8f, 0xbe, 0x5a, 0xf3, 0x60, 0xff, 0x21, 0xee }}
  26.  
  27. /**
  28.  * An interface implemented by a tooltip text provider service. This
  29.  * service is called to discover what tooltip text is associated
  30.  * with the node that the pointer is positioned over.
  31.  *
  32.  * Embedders may implement and register their own tooltip text provider
  33.  * service if they wish to provide different tooltip text. 
  34.  *
  35.  * The default service returns the text stored in the TITLE
  36.  * attribute of the node or a containing parent.
  37.  *
  38.  * @note
  39.  * The tooltip text provider service is registered with the contract
  40.  * defined in NS_TOOLTIPTEXTPROVIDER_CONTRACTID.
  41.  *
  42.  * @see nsITooltipListener
  43.  * @see nsIComponentManager
  44.  * @see nsIDOMNode
  45.  *
  46.  * @status FROZEN
  47.  */
  48. class NS_NO_VTABLE nsITooltipTextProvider : public nsISupports {
  49.  public: 
  50.  
  51.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ITOOLTIPTEXTPROVIDER_IID)
  52.  
  53.   /**
  54.      * Called to obtain the tooltip text for a node.
  55.      *
  56.      * @arg aNode The node to obtain the text from.
  57.      * @arg aText The tooltip text.
  58.      *
  59.      * @return <CODE>PR_TRUE</CODE> if tooltip text is associated
  60.      *         with the node and was returned in the aText argument;
  61.      *         <CODE>PR_FALSE</CODE> otherwise.
  62.      */
  63.   /* boolean getNodeText (in nsIDOMNode aNode, out wstring aText); */
  64.   NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) = 0;
  65.  
  66. };
  67.  
  68. /* Use this macro when declaring classes that implement this interface. */
  69. #define NS_DECL_NSITOOLTIPTEXTPROVIDER \
  70.   NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval); 
  71.  
  72. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  73. #define NS_FORWARD_NSITOOLTIPTEXTPROVIDER(_to) \
  74.   NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) { return _to GetNodeText(aNode, aText, _retval); } 
  75.  
  76. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  77. #define NS_FORWARD_SAFE_NSITOOLTIPTEXTPROVIDER(_to) \
  78.   NS_IMETHOD GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetNodeText(aNode, aText, _retval); } 
  79.  
  80. #if 0
  81. /* Use the code below as a template for the implementation class for this interface. */
  82.  
  83. /* Header file */
  84. class nsTooltipTextProvider : public nsITooltipTextProvider
  85. {
  86. public:
  87.   NS_DECL_ISUPPORTS
  88.   NS_DECL_NSITOOLTIPTEXTPROVIDER
  89.  
  90.   nsTooltipTextProvider();
  91.  
  92. private:
  93.   ~nsTooltipTextProvider();
  94.  
  95. protected:
  96.   /* additional members */
  97. };
  98.  
  99. /* Implementation file */
  100. NS_IMPL_ISUPPORTS1(nsTooltipTextProvider, nsITooltipTextProvider)
  101.  
  102. nsTooltipTextProvider::nsTooltipTextProvider()
  103. {
  104.   /* member initializers and constructor code */
  105. }
  106.  
  107. nsTooltipTextProvider::~nsTooltipTextProvider()
  108. {
  109.   /* destructor code */
  110. }
  111.  
  112. /* boolean getNodeText (in nsIDOMNode aNode, out wstring aText); */
  113. NS_IMETHODIMP nsTooltipTextProvider::GetNodeText(nsIDOMNode *aNode, PRUnichar **aText, PRBool *_retval)
  114. {
  115.     return NS_ERROR_NOT_IMPLEMENTED;
  116. }
  117.  
  118. /* End of implementation class template. */
  119. #endif
  120.  
  121.  
  122. #endif /* __gen_nsITooltipTextProvider_h__ */
  123.